<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Caffe: include/caffe/layers/rnn_layer.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Caffe
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_4b7f3da7c7b4301d805dae0326fb91b7.html">caffe</a></li><li class="navelem"><a class="el" href="dir_b9606a76d4acbf8f90a06a4a51ec8b9e.html">layers</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">rnn_layer.hpp</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#ifndef CAFFE_RNN_LAYER_HPP_</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="preprocessor">#define CAFFE_RNN_LAYER_HPP_</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="preprocessor">#include &lt;utility&gt;</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#include &quot;caffe/blob.hpp&quot;</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor">#include &quot;caffe/common.hpp&quot;</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#include &quot;caffe/layer.hpp&quot;</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#include &quot;caffe/layers/recurrent_layer.hpp&quot;</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="preprocessor">#include &quot;caffe/net.hpp&quot;</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#include &quot;caffe/proto/caffe.pb.h&quot;</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacecaffe.html">caffe</a> {</div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Dtype&gt; <span class="keyword">class </span>RecurrentLayer;</div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Dtype&gt;</div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="classcaffe_1_1RNNLayer.html">   30</a></span>&#160;<span class="keyword">class </span><a class="code" href="classcaffe_1_1RNNLayer.html">RNNLayer</a> : <span class="keyword">public</span> <a class="code" href="classcaffe_1_1RecurrentLayer.html">RecurrentLayer</a>&lt;Dtype&gt; {</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;  <span class="keyword">explicit</span> <a class="code" href="classcaffe_1_1RNNLayer.html">RNNLayer</a>(<span class="keyword">const</span> LayerParameter&amp; param)</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;      : <a class="code" href="classcaffe_1_1RecurrentLayer.html">RecurrentLayer&lt;Dtype&gt;</a>(param) {}</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classcaffe_1_1RNNLayer.html#a4c0d018f595c6627de34555dc0fc553c">   35</a></span>&#160;  <span class="keyword">virtual</span> <span class="keyword">inline</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classcaffe_1_1RNNLayer.html#a4c0d018f595c6627de34555dc0fc553c">type</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">&quot;RNN&quot;</span>; }</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160; <span class="keyword">protected</span>:</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classcaffe_1_1RNNLayer.html#a2869101eb6b9c472f9d78b9149246729">FillUnrolledNet</a>(NetParameter* net_param) <span class="keyword">const</span>;</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classcaffe_1_1RNNLayer.html#a1d753540adb5718db6b66e0aa2c0c4fb">RecurrentInputBlobNames</a>(vector&lt;string&gt;* names) <span class="keyword">const</span>;</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classcaffe_1_1RNNLayer.html#a57d105b9599c294d05fe25b8542e1031">RecurrentOutputBlobNames</a>(vector&lt;string&gt;* names) <span class="keyword">const</span>;</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classcaffe_1_1RNNLayer.html#a586b4a2bb8959315d55c34704325bae6">RecurrentInputShapes</a>(vector&lt;BlobShape&gt;* shapes) <span class="keyword">const</span>;</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classcaffe_1_1RNNLayer.html#a553fdd0dadf2a0cd9e5de265bd65da52">OutputBlobNames</a>(vector&lt;string&gt;* names) <span class="keyword">const</span>;</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;};</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;}  <span class="comment">// namespace caffe</span></div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="preprocessor">#endif  // CAFFE_RNN_LAYER_HPP_</span></div><div class="ttc" id="classcaffe_1_1RNNLayer_html_a553fdd0dadf2a0cd9e5de265bd65da52"><div class="ttname"><a href="classcaffe_1_1RNNLayer.html#a553fdd0dadf2a0cd9e5de265bd65da52">caffe::RNNLayer::OutputBlobNames</a></div><div class="ttdeci">virtual void OutputBlobNames(vector&lt; string &gt; *names) const</div><div class="ttdoc">Fills names with the names of the output blobs, concatenated across all timesteps. Should return a name for each top Blob. Subclasses should define this – see RNNLayer and LSTMLayer for examples. </div><div class="ttdef"><b>Definition:</b> rnn_layer.cpp:36</div></div>
<div class="ttc" id="classcaffe_1_1RNNLayer_html_a586b4a2bb8959315d55c34704325bae6"><div class="ttname"><a href="classcaffe_1_1RNNLayer.html#a586b4a2bb8959315d55c34704325bae6">caffe::RNNLayer::RecurrentInputShapes</a></div><div class="ttdeci">virtual void RecurrentInputShapes(vector&lt; BlobShape &gt; *shapes) const</div><div class="ttdoc">Fills shapes with the shapes of the recurrent input Blob&amp;s. Subclasses should define this – see RNNL...</div><div class="ttdef"><b>Definition:</b> rnn_layer.cpp:26</div></div>
<div class="ttc" id="namespacecaffe_html"><div class="ttname"><a href="namespacecaffe.html">caffe</a></div><div class="ttdoc">A layer factory that allows one to register layers. During runtime, registered layers can be called b...</div><div class="ttdef"><b>Definition:</b> blob.hpp:14</div></div>
<div class="ttc" id="classcaffe_1_1RecurrentLayer_html"><div class="ttname"><a href="classcaffe_1_1RecurrentLayer.html">caffe::RecurrentLayer</a></div><div class="ttdoc">An abstract class for implementing recurrent behavior inside of an unrolled network. This Layer type cannot be instantiated – instead, you should use one of its implementations which defines the recurrent architecture, such as RNNLayer or LSTMLayer. </div><div class="ttdef"><b>Definition:</b> lstm_layer.hpp:17</div></div>
<div class="ttc" id="classcaffe_1_1RNNLayer_html_a2869101eb6b9c472f9d78b9149246729"><div class="ttname"><a href="classcaffe_1_1RNNLayer.html#a2869101eb6b9c472f9d78b9149246729">caffe::RNNLayer::FillUnrolledNet</a></div><div class="ttdeci">virtual void FillUnrolledNet(NetParameter *net_param) const</div><div class="ttdoc">Fills net_param with the recurrent network architecture. Subclasses should define this – see RNNLaye...</div><div class="ttdef"><b>Definition:</b> rnn_layer.cpp:42</div></div>
<div class="ttc" id="classcaffe_1_1RNNLayer_html_a4c0d018f595c6627de34555dc0fc553c"><div class="ttname"><a href="classcaffe_1_1RNNLayer.html#a4c0d018f595c6627de34555dc0fc553c">caffe::RNNLayer::type</a></div><div class="ttdeci">virtual const char * type() const</div><div class="ttdoc">Returns the layer type. </div><div class="ttdef"><b>Definition:</b> rnn_layer.hpp:35</div></div>
<div class="ttc" id="classcaffe_1_1RNNLayer_html_a57d105b9599c294d05fe25b8542e1031"><div class="ttname"><a href="classcaffe_1_1RNNLayer.html#a57d105b9599c294d05fe25b8542e1031">caffe::RNNLayer::RecurrentOutputBlobNames</a></div><div class="ttdeci">virtual void RecurrentOutputBlobNames(vector&lt; string &gt; *names) const</div><div class="ttdoc">Fills names with the names of the Tth timestep recurrent output Blob&amp;s. Subclasses should define this...</div><div class="ttdef"><b>Definition:</b> rnn_layer.cpp:20</div></div>
<div class="ttc" id="classcaffe_1_1RNNLayer_html"><div class="ttname"><a href="classcaffe_1_1RNNLayer.html">caffe::RNNLayer</a></div><div class="ttdoc">Processes time-varying inputs using a simple recurrent neural network (RNN). Implemented as a network...</div><div class="ttdef"><b>Definition:</b> rnn_layer.hpp:30</div></div>
<div class="ttc" id="classcaffe_1_1RNNLayer_html_a1d753540adb5718db6b66e0aa2c0c4fb"><div class="ttname"><a href="classcaffe_1_1RNNLayer.html#a1d753540adb5718db6b66e0aa2c0c4fb">caffe::RNNLayer::RecurrentInputBlobNames</a></div><div class="ttdeci">virtual void RecurrentInputBlobNames(vector&lt; string &gt; *names) const</div><div class="ttdoc">Fills names with the names of the 0th timestep recurrent input Blob&amp;s. Subclasses should define this ...</div><div class="ttdef"><b>Definition:</b> rnn_layer.cpp:14</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Aug 3 2017 23:11:19 for Caffe by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
